home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / IDLIncludes / AppleGuide.idl < prev    next >
Text File  |  1996-05-01  |  3KB  |  151 lines
  1. /*
  2.      File:        AppleGuide.idl
  3.  
  4.      Contains:    Apple Guide Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. */
  18. #ifndef __APPLEGUIDE_IDL__
  19. #define __APPLEGUIDE_IDL__
  20.  
  21. #include <somobj.idl>
  22. #include <somcls.idl>
  23.  
  24. #ifndef __APPLEEVENTS_IDL__
  25. #include <AppleEvents.idl>
  26. #endif
  27. #ifndef __FILES_IDL__
  28. #include <Files.idl>
  29. #endif
  30. #ifndef __TYPES_IDL__
  31. #include <Types.idl>
  32. #endif
  33.  
  34. #ifdef __SOMIDL__
  35.  
  36. #if FOR_SYSTEM7_AND_SYSTEM8_COOPERATIVE
  37. /* Types*/
  38. typedef UInt32                    AGRefNum;
  39.  
  40. typedef UInt32                    AGCoachRefNum;
  41.  
  42. typedef UInt32                    AGContextRefNum;
  43.  
  44. typedef SOMLargeStruct            AGAppInfo;                    /* Derived from a struct of 12 bytes in size */
  45.  
  46. typedef OpaquePtr                AGAppInfoPtr;                /* Substituted OpaquePtr for ``AGAppInfo*'' */
  47.  
  48. typedef OpaquePtr                AGAppInfoHdl;                /* Substituted OpaquePtr for ``AGAppInfoPtr*'' */
  49.  
  50. typedef OpaquePtr CoachReplyProcPtr;
  51. typedef OpaquePtr CoachReplyUPP;
  52. typedef OpaquePtr ContextReplyProcPtr;
  53. typedef OpaquePtr ContextReplyUPP;
  54. /* Constants*/
  55. /* To test against AGGetAvailableDBTypes*/
  56. typedef UInt16                    AGStatus;
  57.  
  58. /* Returned by AGGetStatus*/
  59. typedef UInt16                    AGWindowKind;
  60.  
  61. /* Returned by AGGetFrontWindowKind*/
  62. /*
  63.  Error Codes
  64.  Not an enum, because other OSErrs are valid.
  65. */
  66. typedef SInt16                    AGErr;
  67.  
  68. /* Apple Guide error codes*/
  69. /*
  70.  Events
  71.  Not an enum because we want to make assignments.
  72. */
  73. typedef UInt32                    AGEvent;
  74.  
  75. /* Handy events for AGGeneral.*/
  76. /*
  77.  Functions
  78.  AGClose
  79.  Close the database associated with the AGRefNum.
  80. */
  81. /*
  82.  AGGeneral
  83.  Cause various events to happen.
  84. */
  85. /*
  86.  AGGetAvailableDBTypes
  87.  Return the database types available for this application.
  88. */
  89. /*
  90.  AGGetFrontWindowKind
  91.  Return the kind of the front window.
  92. */
  93. /*
  94.  AGGetFSSpec
  95.  Return the FSSpec for the AGRefNum.
  96. */
  97. /*
  98.  AGGetStatus
  99.  Return the status of Apple Guide.
  100. */
  101. /*
  102.  AGInstallCoachHandler
  103.  Install a Coach object location query handler.
  104. */
  105. /*
  106.  AGInstallContextHandler
  107.  Install a context check query handler.
  108. */
  109. /*
  110.  AGIsDatabaseOpen
  111.  Return true if the database associated with the AGRefNum is open.
  112. */
  113. /*
  114.  AGOpen
  115.  Open a guide database.
  116. */
  117. /*
  118.  AGOpenWithSearch
  119.  Open a guide database and preset a search string.
  120. */
  121. /*
  122.  AGOpenWithSequence
  123.  Open a guide database and display a presentation window sequence.
  124. */
  125. /*
  126.  AGOpenWithView
  127.  Open a guide database and override the default view.
  128. */
  129. /*
  130.  AGQuit
  131.  Make Apple Guide quit.
  132. */
  133. /*
  134.  AGRemoveCoachHandler
  135.  Remove the Coach object location query handler.
  136. */
  137. /*
  138.  AGRemoveContextHandler
  139.  Remove the context check query handler.
  140. */
  141. /*
  142.  AGStart
  143.  Start up Apple Guide in the background.
  144. */
  145. #endif
  146.  
  147. #endif /* __SOMIDL__ */
  148.  
  149. #endif /* __APPLEGUIDE_IDL__ */
  150.  
  151.